OrderedMultiDictionary.View Members

Wintellect PowerCollections

previous page next page

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Syntax

C#
[SerializableAttribute] public class View

Visual Basic (Declaration)
<SerializableAttribute> _ Public Class View

Visual C++
[SerializableAttribute] public ref class View

The OrderedMultiDictionary class that associates values with a key. Unlike an OrderedDictionary, each key can have multiple values associated with it. When indexing an OrderedMultidictionary, instead of a single value associated with a key, you retrieve an enumeration of values.

All of the key are stored in sorted order. Also, the values associated with a given key are kept in sorted order as well.

When constructed, you can chose to allow the same value to be associated with a key multiple times, or only one time.

The OrderedMultiDictionary<(Of <TKey, TValue>)> generic type exposes the following members.

Public Methods

	Name	Description
	Add	Overloaded.
	AddMany	Adds new values to be associated with a key. If duplicate values are permitted, this method always adds new key-value pairs to the dictionary. If duplicate values are not permitted, and key already has a value equal to one of values associated with it, then that value is replaced, and the number of values associate with key is unchanged. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	AsReadOnly	Provides a read-only view of this collection. The returned ICollection<T> provides a view of the collection that prevents modifications to the collection. Use the method to provide access to the collection without allowing changes. Since the returned object is just a view, changes to the collection will be reflected in the view. (Inherited from CollectionBase<(Of <T>)>.)
	Clear	Removes all the keys and values within this view from the underlying OrderedMultiDictionary. (Overrides MultiDictionaryBase<(Of <TKey, TValue>)>..::Clear()().)
	Contains	Overloaded.
	ContainsKey	Tests if the key is present in the part of the dictionary being viewed. (Overrides MultiDictionaryBase<(Of <TKey, TValue>)>..::ContainsKey(TKey).)
	ConvertAll<(Of <TOutput>)>	Convert this collection of items by applying a delegate to each item in the collection. The resulting enumeration contains the result of applying converter to each item in this collection, in order. (Inherited from CollectionBase<(Of <T>)>.)
	CopyTo	Copies all the items in the collection into an array. Implemented by using the enumerator returned from GetEnumerator to get all the items and copy them to the provided array. (Inherited from CollectionBase<(Of <T>)>.)
	CountWhere	Counts the number of items in the collection that satisfy the condition defined by predicate. (Inherited from CollectionBase<(Of <T>)>.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Exists	Determines if the collection contains any item that satisfies the condition defined by predicate. (Inherited from CollectionBase<(Of <T>)>.)
	FindAll	Enumerates the items in the collection that satisfy the condition defined by predicate. (Inherited from CollectionBase<(Of <T>)>.)
	ForEach	Performs the specified action on each item in this collection. (Inherited from CollectionBase<(Of <T>)>.)
	GetEnumerator	Enumerate all the keys in the dictionary, and for each key, the collection of values for that key. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	GetHashCode	Serves as a hash function for a particular type. GetHashCode()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Remove	Overloaded.
	RemoveAll	Removes all the items in the collection that satisfy the condition defined by predicate. (Inherited from CollectionBase<(Of <T>)>.)
	RemoveMany	Overloaded.
	Replace	Replaces all values associated with key with the single value value. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	ReplaceMany	Replaces all values associated with key with a new collection of values. If the collection does not permit duplicate values, and values has duplicate items, then only the last of duplicates is added. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	Reversed	Creates a new View that has the same keys and values as this, in the reversed order.
	ToArray	Creates an array of the correct size, and copies all the items in the collection into the array, by calling CopyTo. (Inherited from CollectionBase<(Of <T>)>.)
	ToString	Shows the string representation of the dictionary. The string representation contains a list of the mappings in the dictionary. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	TrueForAll	Determines if all of the items in the collection satisfy the condition defined by predicate. (Inherited from CollectionBase<(Of <T>)>.)

Protected Methods

	Name	Description
	CountAllValues	Gets a total count of values in the collection. This default implementation is slow; it enumerates all of the keys in the dictionary and calls CountValues on each. A derived class may be able to supply a more efficient implementation. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	CountValues	Gets the number of values associated with a given key. (Overrides MultiDictionaryBase<(Of <TKey, TValue>)>..::CountValues(TKey).)
	EnumerateKeys	Enumerate all the keys in the dictionary. (Overrides MultiDictionaryBase<(Of <TKey, TValue>)>..::EnumerateKeys()().)
	EqualValues	If the derived class does not use the default comparison for values, this methods should be overridden to compare two values for equality. This is used for the correct implementation of ICollection.Contains on the Values and KeyValuePairs collections. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	TryEnumerateValuesForKey	Enumerate all of the values associated with a given key. If the key exists and has values associated with it, an enumerator for those values is returned throught values. If the key does not exist, false is returned. (Overrides MultiDictionaryBase<(Of <TKey, TValue>)>..::TryEnumerateValuesForKey(TKey, IEnumerator<(Of <TValue>)>%).)

Public Properties

	Name	Description
	Count	Number of keys in this view. (Overrides MultiDictionaryBase<(Of <TKey, TValue>)>..::Count.)
	Item	Returns a collection of all of the values in the dictionary associated with key, or changes the set of values associated with key. If the key is not present in the dictionary, an ICollection enumerating no values is returned. The returned collection of values is read-write, and can be used to modify the collection of values associated with the key. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	Keys	Gets a read-only collection all the keys in this dictionary. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	KeyValuePairs	Gets a read-only collection of all key-value pairs in the dictionary. If a key has multiple values associated with it, then a key-value pair is present for each value associated with the key. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	Values	Gets a read-only collection of all the values in the dictionary. (Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)

Explicit Interface Implementations

	Name	Description
	ICollection<(Of <T>)>..::IsReadOnly	(Inherited from CollectionBase<(Of <T>)>.)
	IDictionary<(Of <TKey, ICollection<(Of <TValue>)>>)>..::Add	(Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	IDictionary<(Of <TKey, ICollection<(Of <TValue>)>>)>..::Item	(Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	IDictionary<(Of <TKey, ICollection<(Of <TValue>)>>)>..::TryGetValue	(Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	IDictionary<(Of <TKey, ICollection<(Of <TValue>)>>)>..::Values	(Inherited from MultiDictionaryBase<(Of <TKey, TValue>)>.)
	ICollection..::CopyTo	Copies all the items in the collection into an array. Implemented by using the enumerator returned from GetEnumerator to get all the items and copy them to the provided array. (Inherited from CollectionBase<(Of <T>)>.)
	ICollection..::IsSynchronized	Indicates whether the collection is synchronized. (Inherited from CollectionBase<(Of <T>)>.)
	ICollection..::SyncRoot	Indicates the synchronization object for this collection. (Inherited from CollectionBase<(Of <T>)>.)
	IEnumerable..::GetEnumerator	Provides an IEnumerator that can be used to iterate all the members of the collection. This implementation uses the IEnumerator<T> that was overridden by the derived classes to enumerate the members of the collection. (Inherited from CollectionBase<(Of <T>)>.)